/*
 * Copyright (c) 2023-2024 elsfs Authors. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.elsfs.cloud.api.security.entity;

import java.util.HashSet;
import java.util.Set;
import org.springframework.security.core.CredentialsContainer;
import org.springframework.security.core.userdetails.UserDetails;

/**
 * 用户实体
 *
 * @author zeng
 */
public interface SecurityUserEntity extends UserDetails, CredentialsContainer {
  /**
   * 用户id
   *
   * @return userId
   */
  String getUserId();

  /**
   * 用户名
   *
   * @return username
   */
  String getUsername();

  /**
   * 密码
   *
   * @return password
   */
  String getPassword();

  /**
   * 昵称
   *
   * @return nickname
   */
  String getNickname();

  /**
   * 状态
   *
   * @return validFlag
   */
  String getValidFlag();

  /**
   * 头像
   *
   * @return avatar
   */
  String getAvatar();

  /**
   * 性别
   *
   * @return gender
   */
  String getSex();

  String getPhone();

  String getEmail();

  String getTenantId();

  default Set<String> getDeptIds() {
    return new HashSet<>();
  }
}
